Skip to main content
POST
/
v1
/
aggregators
/
{id}
/
usage
/
events
Get aggregator usage events
curl --request POST \
  --url https://api.hyperline.co/v1/aggregators/{id}/usage/events \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "start_date": "2026-01-01T00:00:00Z",
  "end_date": "2026-02-01T00:00:00Z",
  "aggregator_filter_id": "<string>",
  "take": 50,
  "skip": 0
}
'
{
  "meta": {
    "total": 1,
    "taken": 1,
    "skipped": 0
  },
  "data": [
    {
      "id": "<string>",
      "name": "<string>",
      "timestamp": "<string>",
      "payload": {}
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.hyperline.co/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

Body

application/json
start_date
string<date-time>
required

ISO-8601 date string.

Example:

"2026-01-01T00:00:00Z"

end_date
string<date-time>
required

ISO-8601 date string.

Example:

"2026-02-01T00:00:00Z"

aggregator_filter_id
string

Optional aggregator filter ID. When set, restricts the result to events matching that filter's config. Must belong to the aggregator in the path.

take
number | null
default:50
Required range: 0 <= x <= 100
skip
number | null
default:0
Required range: x >= 0

Response

meta
object
required
data
object[]
required

List of AggregatorUsageEvent.